org.springframework.web.context.request.async

Class MvcAsyncTask<V>

java.lang.Object

org.springframework.web.context.request.async.MvcAsyncTask<V>

public class MvcAsyncTask<V>
extends java.lang.Object

Holder for a Callable, a timeout value, and a task executor.

Since:

3.2

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private BeanFactory	beanFactory
private java.util.concurrent.Callable<V>	callable
private java.lang.Runnable	completionCallback
private AsyncTaskExecutor	executor
private java.lang.String	executorName
private java.lang.Long	timeout
private java.util.concurrent.Callable<V>	timeoutCallback

Constructor Summary

Constructors

Modifier	Constructor and Description
	MvcAsyncTask(java.util.concurrent.Callable<V> callable) Create an MvcAsyncTask wrapping the given Callable.
	MvcAsyncTask(java.lang.Long timeout, AsyncTaskExecutor executor, java.util.concurrent.Callable<V> callable) Create an MvcAsyncTask with a timeout value, an executor instance, and a Callable.
private	MvcAsyncTask(java.lang.Long timeout, AsyncTaskExecutor executor, java.lang.String executorName, java.util.concurrent.Callable<V> callable)
	MvcAsyncTask(long timeout, java.util.concurrent.Callable<V> callable) Create an MvcAsyncTask with a timeout value and a Callable.
	MvcAsyncTask(java.lang.Long timeout, java.lang.String executorName, java.util.concurrent.Callable<V> callable) Create an MvcAsyncTask with a timeout value, an executor name, and a Callable.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.concurrent.Callable<?>	getCallable() Return the Callable to use for concurrent handling, never null.
AsyncTaskExecutor	getExecutor() Return the AsyncTaskExecutor to use for concurrent handling, or null.
(package private) CallableProcessingInterceptor	getInterceptor()
java.lang.Long	getTimeout() Return the timeout value in milliseconds or null if not value is set.
void	onCompletion(java.lang.Runnable callback) Register code to invoke when the async request completes.
void	onTimeout(java.util.concurrent.Callable<V> callback) Register code to invoke when the async request times out.
void	setBeanFactory(BeanFactory beanFactory) A BeanFactory to use to resolve an executor name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

callable

private final java.util.concurrent.Callable<V> callable

timeout

private final java.lang.Long timeout

executorName

private final java.lang.String executorName

executor

private final AsyncTaskExecutor executor

timeoutCallback

private java.util.concurrent.Callable<V> timeoutCallback

completionCallback

private java.lang.Runnable completionCallback

beanFactory

private BeanFactory beanFactory

Constructor Detail

MvcAsyncTask

public MvcAsyncTask(java.util.concurrent.Callable<V> callable)

Create an MvcAsyncTask wrapping the given Callable.

Parameters:

callable - the callable for concurrent handling

MvcAsyncTask

public MvcAsyncTask(long timeout,
            java.util.concurrent.Callable<V> callable)

Create an MvcAsyncTask with a timeout value and a Callable.

Parameters:

timeout - timeout value in milliseconds

callable - the callable for concurrent handling

MvcAsyncTask

public MvcAsyncTask(java.lang.Long timeout,
            java.lang.String executorName,
            java.util.concurrent.Callable<V> callable)

Create an MvcAsyncTask with a timeout value, an executor name, and a Callable.

Parameters:

timeout - timeout value in milliseconds; ignored if null

callable - the callable for concurrent handling

MvcAsyncTask

public MvcAsyncTask(java.lang.Long timeout,
            AsyncTaskExecutor executor,
            java.util.concurrent.Callable<V> callable)

Create an MvcAsyncTask with a timeout value, an executor instance, and a Callable.

Parameters:

timeout - timeout value in milliseconds; ignored if null

callable - the callable for concurrent handling

MvcAsyncTask

private MvcAsyncTask(java.lang.Long timeout,
            AsyncTaskExecutor executor,
            java.lang.String executorName,
            java.util.concurrent.Callable<V> callable)

Method Detail

getCallable

public java.util.concurrent.Callable<?> getCallable()

Return the Callable to use for concurrent handling, never null.

getTimeout

public java.lang.Long getTimeout()

Return the timeout value in milliseconds or null if not value is set.

getExecutor

public AsyncTaskExecutor getExecutor()

Return the AsyncTaskExecutor to use for concurrent handling, or null.

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

A BeanFactory to use to resolve an executor name. Applications are not expected to have to set this property when MvcAsyncTask is used in a Spring MVC controller.

onTimeout

public void onTimeout(java.util.concurrent.Callable<V> callback)

Register code to invoke when the async request times out. This method is called from a container thread when an async request times out before the Callable has completed. The callback is executed in the same thread and therefore should return without blocking. It may return an alternative value to use, including an Exception or return RESULT_NONE.

onCompletion

public void onCompletion(java.lang.Runnable callback)

Register code to invoke when the async request completes. This method is called from a container thread when an async request completed for any reason including timeout and network error.

getInterceptor

CallableProcessingInterceptor getInterceptor()